<html>
<head><meta charset="utf-8"><title>Item Documentation with only // · t-compiler/help · Zulip Chat Archive</title></head>
<h2>Stream: <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/index.html">t-compiler/help</a></h2>
<h3>Topic: <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Item.20Documentation.20with.20only.20.2F.2F.html">Item Documentation with only //</a></h3>

<hr>

<base href="https://rust-lang.zulipchat.com">

<head><link href="https://rust-lang.github.io/zulip_archive/style.css" rel="stylesheet"></head>

<a name="226265913"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/Item%20Documentation%20with%20only%20///near/226265913" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> xFrednet <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Item.20Documentation.20with.20only.20.2F.2F.html#226265913">(Feb 13 2021 at 20:41)</a>:</h4>
<p>This is more a general question. I've by now found several enums and structs inside the compiler which actually have a documenting comment but only use two slashes <code>//</code>. This causes them to not be exported to <a href="http://doc.rust-lang.org">doc.rust-lang.org</a>. Is there a specific reason for this? <span aria-label="upside down" class="emoji emoji-1f643" role="img" title="upside down">:upside_down:</span> <br>
<a href="https://doc.rust-lang.org/nightly/nightly-rustc/src/rustc_typeck/expr_use_visitor.rs.html#27">Example Code</a><br>
<a href="https://doc.rust-lang.org/nightly/nightly-rustc/rustc_typeck/expr_use_visitor/trait.Delegate.html">Resulting doc page</a></p>



<a name="226266640"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/Item%20Documentation%20with%20only%20///near/226266640" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Jonas Schievink  [he/him] <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Item.20Documentation.20with.20only.20.2F.2F.html#226266640">(Feb 13 2021 at 20:54)</a>:</h4>
<p>Not really, they should probably all use <code>///</code> so they show up in the docs</p>



<a name="226266654"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/Item%20Documentation%20with%20only%20///near/226266654" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Jonas Schievink  [he/him] <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Item.20Documentation.20with.20only.20.2F.2F.html#226266654">(Feb 13 2021 at 20:54)</a>:</h4>
<p><code>expr_use_visitor</code> is <em>very</em> legacy code, maybe back then doc comments weren't even a thing</p>



<a name="226266694"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/Item%20Documentation%20with%20only%20///near/226266694" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Matthew Jasper <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Item.20Documentation.20with.20only.20.2F.2F.html#226266694">(Feb 13 2021 at 20:55)</a>:</h4>
<p>The compiler docs definitely were not published when it was written</p>



<a name="226267561"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/Item%20Documentation%20with%20only%20///near/226267561" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> xFrednet <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Item.20Documentation.20with.20only.20.2F.2F.html#226267561">(Feb 13 2021 at 21:10)</a>:</h4>
<p>Interesting^^. I'll try to create a PR for the cases were I notice it then. Thank you!</p>



<hr><p>Last updated: Aug 07 2021 at 22:04 UTC</p>
</html>